home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / content / nsITextContent.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  4KB  |  114 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37. #ifndef nsITextContent_h___
  38. #define nsITextContent_h___
  39.  
  40. #include "nsIContent.h"
  41. class nsString;
  42. class nsTextFragment;
  43.  
  44. // IID for the nsITextContent interface
  45. #define NS_ITEXT_CONTENT_IID \
  46.  {0x3c4cfec2, 0x4438, 0x48df, {0xa2, 0x12, 0x30, 0x5e, 0x5a, 0xd8, 0xbb, 0xa0}}
  47.  
  48. /**
  49.  * Interface for textual content. This interface is used to provide
  50.  * an efficient access to text content.
  51.  */
  52. class nsITextContent : public nsIContent {
  53. public:
  54.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ITEXT_CONTENT_IID)
  55.  
  56.   /**
  57.    * Get direct access (but read only) to the text in the text content.
  58.    */
  59.   virtual const nsTextFragment *Text() = 0;
  60.  
  61.   /**
  62.    * Get the length of the text content.
  63.    */
  64.   virtual PRUint32 TextLength() = 0;
  65.  
  66.   /**
  67.    * Set the text to the given value. If aNotify is PR_TRUE then
  68.    * the document is notified of the content change.
  69.    */
  70.   virtual void SetText(const PRUnichar* aBuffer, PRUint32 aLength,
  71.                        PRBool aNotify) = 0;
  72.  
  73.   /**
  74.    * Set the text to the given value. If aNotify is PR_TRUE then
  75.    * the document is notified of the content change.
  76.    */
  77.   virtual void SetText(const nsAString& aStr, PRBool aNotify) = 0;
  78.  
  79.   /**
  80.    * Set the text to the given value. If aNotify is PR_TRUE then
  81.    * the document is notified of the content change.
  82.    */
  83.   virtual void SetText(const char* aBuffer, PRUint32 aLength,
  84.                        PRBool aNotify) = 0;
  85.  
  86.   /**
  87.    * Query method to see if the frame is nothing but whitespace
  88.    */
  89.   virtual PRBool IsOnlyWhitespace() = 0;
  90.  
  91.   /**
  92.    * Append the text content to aResult.
  93.    */
  94.   virtual void AppendTextTo(nsAString& aResult) = 0;
  95. };
  96.  
  97. // XXX These belong elsewhere
  98. /**
  99.  * There's no need to pass in aOwnerDocument if the node is going to be
  100.  * inserted *immediately* after creation.
  101.  */
  102. nsresult
  103. NS_NewTextNode(nsITextContent **aResult, nsIDocument *aOwnerDocument = nsnull);
  104.  
  105. /**
  106.  * There's no need to pass in aOwnerDocument if the node is going to be
  107.  * inserted *immediately* after creation.
  108.  */
  109. nsresult
  110. NS_NewCommentNode(nsIContent **aResult, nsIDocument *aOwnerDocument = nsnull);
  111.  
  112.  
  113. #endif /* nsITextContent_h___ */
  114.